Skip to content

docs: add usage example with screenshot to readme - #31

Merged
rsubrama83 merged 1 commit into
mainfrom
docs/readme-usage-example
Oct 2, 2026
Merged

rsubrama83 merged 1 commit into
mainfrom
docs/readme-usage-example

Conversation

@rsubrama83

Copy link
Copy Markdown
Collaborator

Summary

Closes #22. Extends the "Let's get started" section of README.md with:

  • Installation: dotnet add package ShinyPDF, plus the two Linux native asset packages consumers need since 2.0.0 (Remove Native Assets from Nuget Package #18)
  • Example: a complete "Hello PDF!" document (header, text, image, footer with page number) built with the Fluent API
  • Screenshot: docs/img/example-hello-pdf.png, the page rendered by that exact code, with a 1px border so the white page stays visible on GitHub's light theme

Verification

  • The README code block was extracted verbatim into a console app (public API only, no InternalsVisibleTo) and run: it builds without warnings and writes hello.pdf.
  • The screenshot was generated from the same code with GenerateImages.
  • The Linux instructions were checked against the published 2.0.1 package in WSL Ubuntu 24.04:
    • without the native asset packages: crash with DllNotFoundException: Unable to load shared library 'libSkiaSharp'
    • with SkiaSharp.NativeAssets.Linux + HarfBuzzSharp.NativeAssets.Linux: runs and writes the PDF

docs: commit, so merging does not trigger a release.

🤖 Generated with Claude Code

Show how to install the package (including the Linux native assets that
consumers need since 2.0.0) and a complete Hello PDF example with an
image of the generated page.

Closes #22

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@rsubrama83
rsubrama83 merged commit 6e53605 into main Oct 2, 2026
1 check passed
@rsubrama83
rsubrama83 deleted the docs/readme-usage-example branch October 2, 2026 12:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Example usage in readme

2 participants